<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilloader: xloader_client.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilloader
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xloader__client_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xloader_client.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file Contains the client function prototypes, defines and macros. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00  dd   01/09/24 Initial release
      har  03/05/24 Fixed doxygen warnings
      pre  08/22/24 Added XLoader_CfiSelectiveReadback, XLoader_InputSlrIndex functions
      pre  10/26/24 Removed XLoader_LoadReadBackPdi API</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a763acba7e7932449564354fc2b968da0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a763acba7e7932449564354fc2b968da0">XLOADER_SLR_INDEX_SHIFT</a>&#160;&#160;&#160;(6U)</td></tr>
<tr class="memdesc:a763acba7e7932449564354fc2b968da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; shift constant to place slr id  <a href="#a763acba7e7932449564354fc2b968da0">More...</a><br/></td></tr>
<tr class="separator:a763acba7e7932449564354fc2b968da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dc0eb565883b5428c9931d8870d0d92"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a3dc0eb565883b5428c9931d8870d0d92">XLOADER_SLR_INDEX_0</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:a3dc0eb565883b5428c9931d8870d0d92"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 0.  <a href="#a3dc0eb565883b5428c9931d8870d0d92">More...</a><br/></td></tr>
<tr class="separator:a3dc0eb565883b5428c9931d8870d0d92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69ab29a2b2518f74984d9eb1fd430656"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a69ab29a2b2518f74984d9eb1fd430656">XLOADER_SLR_INDEX_1</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:a69ab29a2b2518f74984d9eb1fd430656"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 1.  <a href="#a69ab29a2b2518f74984d9eb1fd430656">More...</a><br/></td></tr>
<tr class="separator:a69ab29a2b2518f74984d9eb1fd430656"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade2f0cb0c26fea0151cc5ad38a1a9d96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#ade2f0cb0c26fea0151cc5ad38a1a9d96">XLOADER_SLR_INDEX_2</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:ade2f0cb0c26fea0151cc5ad38a1a9d96"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 2.  <a href="#ade2f0cb0c26fea0151cc5ad38a1a9d96">More...</a><br/></td></tr>
<tr class="separator:ade2f0cb0c26fea0151cc5ad38a1a9d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a476a2b42c45582de2fb802c603fbb2f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a476a2b42c45582de2fb802c603fbb2f6">XLOADER_SLR_INDEX_3</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:a476a2b42c45582de2fb802c603fbb2f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 3.  <a href="#a476a2b42c45582de2fb802c603fbb2f6">More...</a><br/></td></tr>
<tr class="separator:a476a2b42c45582de2fb802c603fbb2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af14fcbd99f3aaf94c6ecc1f3689b8485"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#af14fcbd99f3aaf94c6ecc1f3689b8485">XLOADER_PDI_SRC_DDR</a>&#160;&#160;&#160;(0xF)</td></tr>
<tr class="memdesc:af14fcbd99f3aaf94c6ecc1f3689b8485"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source of PDI is DDR.  <a href="#af14fcbd99f3aaf94c6ecc1f3689b8485">More...</a><br/></td></tr>
<tr class="separator:af14fcbd99f3aaf94c6ecc1f3689b8485"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bf2f25bb888f10360209991f0fa866a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a8bf2f25bb888f10360209991f0fa866a">XLOADER_PDI_SRC_IS</a>&#160;&#160;&#160;(0x10)</td></tr>
<tr class="memdesc:a8bf2f25bb888f10360209991f0fa866a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source of PDI is Image Store.  <a href="#a8bf2f25bb888f10360209991f0fa866a">More...</a><br/></td></tr>
<tr class="separator:a8bf2f25bb888f10360209991f0fa866a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a80466c7a413948d606d725278a61df96"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96">XLoader_PdiSrc</a> { <br/>
&#160;&#160;<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a54fc0df17f24b2015c616015a18a2a07">XLOADER_PDI_JTAG</a> = 0,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a3d4fd963cf876f96fac9c04b5ee27632">XLOADER_PDI_QSPI24</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a844aeb9fcfa9ec271216b66230accf0c">XLOADER_PDI_QSPI32</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a8c8e893ea7d55252f5ee53e1211dc810">XLOADER_PDI_SD0</a>,
<br/>
&#160;&#160;<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a41fb8fa21e3676baaaab1df041093c2c">XLOADER_PDI_EMMC0</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96aabe7bc4e3615e76c6fc0826f89315824">XLOADER_PDI_SD1</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96aad668e359c43097669d9cd9ef7784af4">XLOADER_PDI_EMMC1</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a0f39e8040d194463257a81b8663ea6bd">XLOADER_PDI_USB</a>,
<br/>
&#160;&#160;<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a2e5c4b41351f8c4fab0bd84370dc0f16">XLOADER_PDI_OSPI</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a217e85995e8e02134b43cb8980a3127c">XLOADER_PDI_SBI</a>,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96ae4ff1d5efb67fd336153d08cf6c4fa3d">XLOADER_PDI_SMAP</a> = 0xAU,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96aa6fc3e3386824c348feef2cbecf60953">XLOADER_PDI_PCIE</a>,
<br/>
&#160;&#160;<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96ac41ba6ad99bf183af9a6c85e47630db2">XLOADER_PDI_SD1_LS</a> = 0XEU,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96ad6b608761502ac7d49c78cbc683d0af5">XLOADER_PDI_DDR</a> = 0xFU,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a3b088d317d60f263f03ea0ad73f06ade">XLOADER_PDI_IS</a> = 0x10U,
<a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96a59f92b4b4b06c373969520417060ed19">XLOADER_PDI_INVALID</a> = 0xFFU
<br/>
 }</td></tr>
<tr class="separator:a80466c7a413948d606d725278a61df96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bfb7027b81951f1f5d157b1de5ce15c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15c">XLoader_FlashType</a> { <a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15ca9d728e3fe53008b745d30b9de829627b">XLOADER_FLASH_RAW</a> = 0,
<a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15ca283da86e0b9d035a75ededf536828636">XLOADER_FLASH_FS</a>,
<a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15ca7a0172f28d7280e05ae952d4301543dd">XLOADER_FLASH_RAW_BP1</a>,
<a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15ca31da791620cb70cc57a138adba3492b1">XLOADER_FLASH_RAW_BP2</a>
 }</td></tr>
<tr class="separator:a3bfb7027b81951f1f5d157b1de5ce15c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa46059a11b24bca179cdb16cec9d5e03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaa46059a11b24bca179cdb16cec9d5e03">XLoader_LoadPartialPdi</a> (XLoader_ClientInstance *InstancePtr, <a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96">XLoader_PdiSrc</a> PdiSrc, u64 PdiAddr, u32 *PlmErrStatus)</td></tr>
<tr class="memdesc:gaa46059a11b24bca179cdb16cec9d5e03"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to provides PDI execution.  <a href="group__xloader__client__apis.html#gaa46059a11b24bca179cdb16cec9d5e03">More...</a><br/></td></tr>
<tr class="separator:gaa46059a11b24bca179cdb16cec9d5e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05ffa5255e46703e2b3762b3841104bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga05ffa5255e46703e2b3762b3841104bc">XLoader_LoadImage</a> (XLoader_ClientInstance *InstancePtr, u32 NodeId, u32 FunctionId)</td></tr>
<tr class="memdesc:ga05ffa5255e46703e2b3762b3841104bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Load image.  <a href="group__xloader__client__apis.html#ga05ffa5255e46703e2b3762b3841104bc">More...</a><br/></td></tr>
<tr class="separator:ga05ffa5255e46703e2b3762b3841104bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac98e60c304d3cc096b362373ae9eb29e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gac98e60c304d3cc096b362373ae9eb29e">XLoader_GetImageInfo</a> (XLoader_ClientInstance *InstancePtr, u32 NodeId, XLoader_ImageInfo *ImageInfo)</td></tr>
<tr class="memdesc:gac98e60c304d3cc096b362373ae9eb29e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get image information.  <a href="group__xloader__client__apis.html#gac98e60c304d3cc096b362373ae9eb29e">More...</a><br/></td></tr>
<tr class="separator:gac98e60c304d3cc096b362373ae9eb29e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4737ad97892352c05d25dc687aa87a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gac4737ad97892352c05d25dc687aa87a1">XLoader_GetImageInfoList</a> (XLoader_ClientInstance *InstancePtr, u64 Buff_Addr, u32 Maxsize, u32 *NumEntries)</td></tr>
<tr class="memdesc:gac4737ad97892352c05d25dc687aa87a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to gets ImageInfo Table.  <a href="group__xloader__client__apis.html#gac4737ad97892352c05d25dc687aa87a1">More...</a><br/></td></tr>
<tr class="separator:gac4737ad97892352c05d25dc687aa87a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e571b298df7278911edeb130a4917c6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga6e571b298df7278911edeb130a4917c6">XLoader_ExtractMetaheader</a> (XLoader_ClientInstance *InstancePtr, u64 PdiSrcAddr, u64 DestBuffAddr, u32 DestBuffSize)</td></tr>
<tr class="memdesc:ga6e571b298df7278911edeb130a4917c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Extract meta header.  <a href="group__xloader__client__apis.html#ga6e571b298df7278911edeb130a4917c6">More...</a><br/></td></tr>
<tr class="separator:ga6e571b298df7278911edeb130a4917c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29c0d281ad005ea2b4a987b8c1008694"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga29c0d281ad005ea2b4a987b8c1008694">XLoader_UpdateMultiboot</a> (XLoader_ClientInstance *InstancePtr, <a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96">XLoader_PdiSrc</a> BootMode, <a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15c">XLoader_FlashType</a> Type, u32 ImageLocation)</td></tr>
<tr class="memdesc:ga29c0d281ad005ea2b4a987b8c1008694"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to update multiboot.  <a href="group__xloader__client__apis.html#ga29c0d281ad005ea2b4a987b8c1008694">More...</a><br/></td></tr>
<tr class="separator:ga29c0d281ad005ea2b4a987b8c1008694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63d94db8c3d206242d0527631c38c5fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga63d94db8c3d206242d0527631c38c5fa">XLoader_AddImageStorePdi</a> (XLoader_ClientInstance *InstancePtr, u32 PdiId, const u64 PdiAddr, u32 PdiSize)</td></tr>
<tr class="memdesc:ga63d94db8c3d206242d0527631c38c5fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to add Image store pdi.  <a href="group__xloader__client__apis.html#ga63d94db8c3d206242d0527631c38c5fa">More...</a><br/></td></tr>
<tr class="separator:ga63d94db8c3d206242d0527631c38c5fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2027ee38324a120aa3f23eb6a1f3476f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga2027ee38324a120aa3f23eb6a1f3476f">XLoader_RemoveImageStorePdi</a> (XLoader_ClientInstance *InstancePtr, u32 PdiId)</td></tr>
<tr class="memdesc:ga2027ee38324a120aa3f23eb6a1f3476f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to remove Image store pdi.  <a href="group__xloader__client__apis.html#ga2027ee38324a120aa3f23eb6a1f3476f">More...</a><br/></td></tr>
<tr class="separator:ga2027ee38324a120aa3f23eb6a1f3476f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf07025194b841bfa9aa96bdb87cb48c8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaf07025194b841bfa9aa96bdb87cb48c8">XLoader_GetATFHandOffParams</a> (XLoader_ClientInstance *InstancePtr, u64 BuffAddr, u32 Size, u32 *BufferSize)</td></tr>
<tr class="memdesc:gaf07025194b841bfa9aa96bdb87cb48c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get ATF Handoff parameters.  <a href="group__xloader__client__apis.html#gaf07025194b841bfa9aa96bdb87cb48c8">More...</a><br/></td></tr>
<tr class="separator:gaf07025194b841bfa9aa96bdb87cb48c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabb2d5baeb7ebd06f2743edc48b28674"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaabb2d5baeb7ebd06f2743edc48b28674">XLoader_CfiSelectiveReadback</a> (XLoader_ClientInstance *InstancePtr, XLoader_CfiSelReadbackParams *SelectiveReadbackPtr)</td></tr>
<tr class="memdesc:gaabb2d5baeb7ebd06f2743edc48b28674"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to read selective frames from configuration memory.  <a href="group__xloader__client__apis.html#gaabb2d5baeb7ebd06f2743edc48b28674">More...</a><br/></td></tr>
<tr class="separator:gaabb2d5baeb7ebd06f2743edc48b28674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga048d2ad178b4c29a0f491b49f9e5788f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga048d2ad178b4c29a0f491b49f9e5788f">XLoader_InputSlrIndex</a> (XLoader_ClientInstance *InstancePtr, u32 SlrIndex)</td></tr>
<tr class="memdesc:ga048d2ad178b4c29a0f491b49f9e5788f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the SLR Index.  <a href="group__xloader__client__apis.html#ga048d2ad178b4c29a0f491b49f9e5788f">More...</a><br/></td></tr>
<tr class="separator:ga048d2ad178b4c29a0f491b49f9e5788f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8960e12865539b0b9a6c2e5f6a705ed7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga8960e12865539b0b9a6c2e5f6a705ed7">XLoader_GetOptionalData</a> (XLoader_ClientInstance *InstancePtr, const XLoader_OptionalDataInfo *OptionalDataInfo, u64 DestAddr, u32 *DestSize)</td></tr>
<tr class="memdesc:ga8960e12865539b0b9a6c2e5f6a705ed7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get optional data from the PDI available in DDR or Image Store.  <a href="group__xloader__client__apis.html#ga8960e12865539b0b9a6c2e5f6a705ed7">More...</a><br/></td></tr>
<tr class="separator:ga8960e12865539b0b9a6c2e5f6a705ed7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="af14fcbd99f3aaf94c6ecc1f3689b8485"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_PDI_SRC_DDR&#160;&#160;&#160;(0xF)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source of PDI is DDR. </p>

<p>Referenced by <a class="el" href="group__xloader__server__apis.html#ga7a4c313af5a0caa20fa13c561ba0f04a">XLoader_DdrRelease()</a>, <a class="el" href="2ve__2vm_2xloader__plat_8h.html#ga5c26bcc51fa70b2692ec7448a69422a0">XLoader_DumpDdrmcRegisters()</a>, <a class="el" href="group__xloader__client__apis.html#ga8960e12865539b0b9a6c2e5f6a705ed7">XLoader_GetOptionalData()</a>, <a class="el" href="group__xloader__server__apis.html#ga00abb3a6ba0436f171b8a00656d93057">XLoader_InitPdiInstanceForExtractMHAndOptData()</a>, <a class="el" href="group__xloader__server__apis.html#gad3082e333a47e4fea07fba25bba8582e">XLoader_LoadLpdAndPsmElf()</a>, and <a class="el" href="group__xloader__server__apis.html#ga3dbbecc3b2545a3e076d421f086715e6">XLoader_RestartImage()</a>.</p>

</div>
</div>
<a class="anchor" id="a8bf2f25bb888f10360209991f0fa866a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_PDI_SRC_IS&#160;&#160;&#160;(0x10)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source of PDI is Image Store. </p>

<p>Referenced by <a class="el" href="group__xloader__client__apis.html#ga8960e12865539b0b9a6c2e5f6a705ed7">XLoader_GetOptionalData()</a>.</p>

</div>
</div>
<a class="anchor" id="a3dc0eb565883b5428c9931d8870d0d92"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_SLR_INDEX_0&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 0. </p>

<p>Referenced by <a class="el" href="group__xloader__client__example__apis.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a69ab29a2b2518f74984d9eb1fd430656"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_SLR_INDEX_1&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 1. </p>

</div>
</div>
<a class="anchor" id="ade2f0cb0c26fea0151cc5ad38a1a9d96"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_SLR_INDEX_2&#160;&#160;&#160;(2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 2. </p>

</div>
</div>
<a class="anchor" id="a476a2b42c45582de2fb802c603fbb2f6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_SLR_INDEX_3&#160;&#160;&#160;(3U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 3. </p>

<p>Referenced by <a class="el" href="group__xloader__client__apis.html#ga048d2ad178b4c29a0f491b49f9e5788f">XLoader_InputSlrIndex()</a>.</p>

</div>
</div>
<a class="anchor" id="a763acba7e7932449564354fc2b968da0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XLOADER_SLR_INDEX_SHIFT&#160;&#160;&#160;(6U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>&lt; shift constant to place slr id </p>
<p>SlrIndexs constants </p>

<p>Referenced by <a class="el" href="group__xloader__client__apis.html#gaabb2d5baeb7ebd06f2743edc48b28674">XLoader_CfiSelectiveReadback()</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a3bfb7027b81951f1f5d157b1de5ce15c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15c">XLoader_FlashType</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a3bfb7027b81951f1f5d157b1de5ce15ca9d728e3fe53008b745d30b9de829627b"></a>XLOADER_FLASH_RAW</em>&nbsp;</td><td class="fielddoc">
<p>0 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3bfb7027b81951f1f5d157b1de5ce15ca283da86e0b9d035a75ededf536828636"></a>XLOADER_FLASH_FS</em>&nbsp;</td><td class="fielddoc">
<p>1 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3bfb7027b81951f1f5d157b1de5ce15ca7a0172f28d7280e05ae952d4301543dd"></a>XLOADER_FLASH_RAW_BP1</em>&nbsp;</td><td class="fielddoc">
<p>2 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3bfb7027b81951f1f5d157b1de5ce15ca31da791620cb70cc57a138adba3492b1"></a>XLOADER_FLASH_RAW_BP2</em>&nbsp;</td><td class="fielddoc">
<p>3 </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="a80466c7a413948d606d725278a61df96"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96">XLoader_PdiSrc</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a54fc0df17f24b2015c616015a18a2a07"></a>XLOADER_PDI_JTAG</em>&nbsp;</td><td class="fielddoc">
<p>0U PDI source JTAG </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a3d4fd963cf876f96fac9c04b5ee27632"></a>XLOADER_PDI_QSPI24</em>&nbsp;</td><td class="fielddoc">
<p>1U PDI source QSPI24 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a844aeb9fcfa9ec271216b66230accf0c"></a>XLOADER_PDI_QSPI32</em>&nbsp;</td><td class="fielddoc">
<p>2U PDI source QSPI32 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a8c8e893ea7d55252f5ee53e1211dc810"></a>XLOADER_PDI_SD0</em>&nbsp;</td><td class="fielddoc">
<p>3U PDI source SD0 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a41fb8fa21e3676baaaab1df041093c2c"></a>XLOADER_PDI_EMMC0</em>&nbsp;</td><td class="fielddoc">
<p>4U PDI source EMMC0 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96aabe7bc4e3615e76c6fc0826f89315824"></a>XLOADER_PDI_SD1</em>&nbsp;</td><td class="fielddoc">
<p>5U PDI source SD1 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96aad668e359c43097669d9cd9ef7784af4"></a>XLOADER_PDI_EMMC1</em>&nbsp;</td><td class="fielddoc">
<p>6U PDI source EMMC1 </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a0f39e8040d194463257a81b8663ea6bd"></a>XLOADER_PDI_USB</em>&nbsp;</td><td class="fielddoc">
<p>7U PDI source USB </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a2e5c4b41351f8c4fab0bd84370dc0f16"></a>XLOADER_PDI_OSPI</em>&nbsp;</td><td class="fielddoc">
<p>8U PDI source OSPI </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a217e85995e8e02134b43cb8980a3127c"></a>XLOADER_PDI_SBI</em>&nbsp;</td><td class="fielddoc">
<p>9U PDI source SBI </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96ae4ff1d5efb67fd336153d08cf6c4fa3d"></a>XLOADER_PDI_SMAP</em>&nbsp;</td><td class="fielddoc">
<p>0xAU PDI source SMAP </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96aa6fc3e3386824c348feef2cbecf60953"></a>XLOADER_PDI_PCIE</em>&nbsp;</td><td class="fielddoc">
<p>0xBU PDI source PCIE </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96ac41ba6ad99bf183af9a6c85e47630db2"></a>XLOADER_PDI_SD1_LS</em>&nbsp;</td><td class="fielddoc">
<p>0xEU PDI source SD1-LS </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96ad6b608761502ac7d49c78cbc683d0af5"></a>XLOADER_PDI_DDR</em>&nbsp;</td><td class="fielddoc">
<p>0xFU PDI source DDR </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a3b088d317d60f263f03ea0ad73f06ade"></a>XLOADER_PDI_IS</em>&nbsp;</td><td class="fielddoc">
<p>0x10U PDI source Image Store </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a80466c7a413948d606d725278a61df96a59f92b4b4b06c373969520417060ed19"></a>XLOADER_PDI_INVALID</em>&nbsp;</td><td class="fielddoc">
<p>0xFFU PDI source invalid </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
